Retrieve Merchant
Request to retrieve merchant's configuration on QNB ALAHLI.
Authentication
This operation requires authentication via one of the following methods:
- Certificate authentication.
-
To authenticate to the API two additional NVP parameters must be supplied in the request.
Provide 'MSO.
<your gateway MSO ID>' in the apiUsername field and your API password in the apiPassword field.
Request
Fields
String
= RETRIEVE_MERCHANT
FIXED
Any sequence of zero or more unicode characters.
String
OPTIONAL
A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Data can consist of any characters
Alphanumeric + additional characters
REQUIRED
The unique identifier issued to you by your payment provider.
This identifier can be up to 12 characters in length.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Alphanumeric + additional characters
REQUIRED
The identifier that uniquely identifies you on the gateway.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.'
Response
Fields
String
CONDITIONAL
A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Data can consist of any characters
The merchant's details.
Details about the merchant acquirer link.
Please note:
- Not all fields are supported for all acquirers, please refer to the Online Integration Guide for details.
- You cannot delete a merchant acquirer link, however you can set merchantAcquirerLink.status to DISABLED.
Alphanumeric + additional characters
CONDITIONAL
An identifier to uniquely identify an acquirer link for the merchant on the gateway.
Use this identifier to specify an acquirer link when updating details for that acquirer link.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Boolean
CONDITIONAL
Allows you to enable the Account Updater functionality for this merchant acquirer link.
Account Updater provides updates received on cardholder accounts from participating issuers to the associated card schemes. To enable the merchant to receive these updates, your merchant must register for this feature with the acquirer and the associated card schemes.
Enabling this feature automatically activates the Token Maintenance Service, which attempts to ensure that the card details stored against a token are current thereby increasing the likelihood of successfully processing a recurring payment that uses the token.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
String
ALWAYS PROVIDED
The unique identifier for the acquirer issued by the gateway.
Please contact your payment service provider for a list of supported acquirers and their ID.
Data can consist of any characters
Enumeration
CONDITIONAL
The transaction frequency the merchant will be allowed to set when initiating a transaction.
You may select multiple transaction frequencies.
Value must be a member of the following list. The values are case sensitive.
INSTALLMENTS
The transaction identifies a payment that is paid off in installments.
RECURRING
The transaction is one in a number of recurring payments.
SINGLE_TRANSACTION
The transaction identifies a one-off payment.
Enumeration
CONDITIONAL
The transaction sources the merchant will be allowed to set when initiating a transaction.
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
The merchant can set Call Centre as the transaction source when initiating a transaction.
CARD_PRESENT
The merchant can set Card Present as the transaction source when initiating a transaction.
INTERNET
The merchant can set Internet as the transaction source when initiating a transaction.
MAIL_ORDER
The merchant can set Mail Order as the transaction source when initiating a transaction.
MOTO
The merchant can set Mail Order/Telephone Order (MOTO) as the transaction source when initiating a transaction.
TELEPHONE_ORDER
The merchant can set Telephone Order as the transaction source when initiating a transaction.
VOICE_RESPONSE
The merchant can set Voice Response as the transaction source when initiating a transaction.
String
CONDITIONAL
The time each day, at which automatic settlement of transactions with the acquirer should be triggered by the gateway.
Data can consist of any characters
Digits
CONDITIONAL
The industry code that the merchant operates in, as used by the financial institution.
Data is a string that consists of the characters 0-9.
String
CONDITIONAL
The Bank Merchant ID/SE Number is an identifier allocated to the merchant by their acquiring bank.
If you set up more than one acquirer link for a single acquirer, these do not need to use the same Bank Merchant ID.
Data can consist of any characters
String
CONDITIONAL
The list of valid card types supported by this merchant acquirer link.
Data can consist of any characters
String
ALWAYS PROVIDED
The list of currencies supported for this merchant acquirer link, expressed using the three-letter alphabetic code according to ISO-4217must be provided, e.g. "USD" for United States Dollar.
Data can consist of any characters
String
ALWAYS PROVIDED
This field triggers custom processing.
MasterCard will inform you if this is applicable to your merchants.
Data can consist of any characters
String
ALWAYS PROVIDED
The merchants default transaction frequency must be one of the allowable transaction frequencies for this merchant.
Defines the transaction frequency set, if none has been provided for that transaction.
Data can consist of any characters
Enumeration
ALWAYS PROVIDED
The merchants default transaction source must be one of the allowable transaction sources for this merchant.
Defines the transaction source sent to the acquirer, if none has been provided for that transaction.
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
The merchant can set Call Centre as the transaction source when initiating a transaction.
CARD_PRESENT
The merchant can set Card Present as the transaction source when initiating a transaction.
INTERNET
The merchant can set Internet as the transaction source when initiating a transaction.
MAIL_ORDER
The merchant can set Mail Order as the transaction source when initiating a transaction.
MOTO
The merchant can set Mail Order/Telephone Order (MOTO) as the transaction source when initiating a transaction.
TELEPHONE_ORDER
The merchant can set Telephone Order as the transaction source when initiating a transaction.
VOICE_RESPONSE
The merchant can set Voice Response as the transaction source when initiating a transaction.
Enumeration
CONDITIONAL
Allows you to specify transaction sources for which a Card Security Code (CSC) must be provided when processing transactions using this merchant acquirer link.
CSC enforcement does not apply to: - Card Present transactions - transactions where the transaction frequency is Recurring or Installment. - transactions where the merchant has the 'May Use No CSC Printed on Card' merchant privilege enabled, and the merchant operator selects the 'No CSC Printed on Card' option when creating an order. - transactions with Maestro cards for a transaction source of Internet. CSC enforcement only applies to Authorization, Purchase, and Standalone Capture transactions."
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
The merchant can set Call Centre as the transaction source when initiating a transaction.
CARD_PRESENT
The merchant can set Card Present as the transaction source when initiating a transaction.
INTERNET
The merchant can set Internet as the transaction source when initiating a transaction.
MAIL_ORDER
The merchant can set Mail Order as the transaction source when initiating a transaction.
MOTO
The merchant can set Mail Order/Telephone Order (MOTO) as the transaction source when initiating a transaction.
TELEPHONE_ORDER
The merchant can set Telephone Order as the transaction source when initiating a transaction.
VOICE_RESPONSE
The merchant can set Voice Response as the transaction source when initiating a transaction.
String
CONDITIONAL
Description of the goods sold by the merchant, for example, books or electronics.
Data can consist of any characters
Details regarding payment plans supported for this merchant acquirer link.
String
CONDITIONAL
The list of valid card types supported by this merchant acquirer link.
Data can consist of any characters
Digits
CONDITIONAL
The maximum number of installments that is supported for this merchant acquirer link.
Please refer to the Online Integration Guide for the allowed values depending on the payment plans.
Data is a string that consists of the characters 0-9.
Decimal
CONDITIONAL
The maximum number of installments that is supported for this merchant acquirer link.
Please refer to the Online Integration Guide for the allowed values depending on the payment plans.
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
String
CONDITIONAL
The ID of the payment plan you want to enable for the merchant acquirer link (e.g. PlanN).
Please refer to the Online Integration Guide for the payment plans supported and their IDs.
Data can consist of any characters
String
ALWAYS PROVIDED
The payment types supported by this acquirer via this merchant acquirer link.
Data can consist of any characters
Enumeration
ALWAYS PROVIDED
Defines if the merchant can use the acquirer link and if so, for what purpose.
Note:
Setting the value to FALLBACK can be used to support moving processing of the merchant's transactions from one acquirer link to another.
When moving transaction processing from one link to another, the status of the new link is set to TEST_AND_PRODUCTION or TEST_ONLY, and the status of the old link is set to FALLBACK. In this case,
- New orders will be processed using the new link, and
- Subsequent transactions for orders created using the old link will be processed on the old link.
Value must be a member of the following list. The values are case sensitive.
DISABLED
The acquirer link can no longer be used by the merchant.
FALLBACK
The acquirer link is used to process transactions when no other suitable test or production link is available, or to process subsequent transactions on a order that was created on this link.
TEST_AND_PRODUCTION
The acquirer link can be used for testing and processing live transactions.
TEST_ONLY
The acquirer link can be used for testing only but not processing live transactions.
String
CONDITIONAL
The unique identifiers for the terminal IDs, that the acquirer assigned to the merchant.
Data can consist of any characters
Digits
CONDITIONAL
The Merchant Verification Value (MVV) assigned to the merchant by Visa.
Value will be submitted to the acquirer on transaction requests with card type Visa (if supported).
Data is a string that consists of the characters 0-9.
Details about the 3D-Secure configuration for this merchant acquirer link.
Details about the American Express SafeKey (3D-Secure) configuration for this merchant acquirer link.
String
CONDITIONAL
Merchant ID provided to the merchant by their acquirer when they registered to use American Express SafeKey.
Data can consist of any characters
Details about the Diners ProtectBuy (3D-Secure) configuration for this merchant acquirer link.
String
CONDITIONAL
Merchant ID provided to the merchant by their acquirer when they registered to use Diners ProtectBuy.
Data can consist of any characters
Enumeration
CONDITIONAL
Controls whether 3DS interactions are required for transactions processing on this link.
Does not apply to transactions where the transaction frequency is Recurring or Installment. Only applies to Authorization, Purchase and Standalone Capture transactions. The default behaviour is not to require 3DS interaction.
Value must be a member of the following list. The values are case sensitive.
NOT_ENFORCED
Transactions are not rquired to have valid 3DS interactions.
ON_INTERNET_TRANSACTIONS
Transactions with a transaction source of INTERNET require a valid 3DS interaction. If the cardholder is enrolled then the authentication must be successful.
Details about the J/Secure (3D-Secure) configuration for this merchant acquirer link.
String
CONDITIONAL
Merchant ID provided to the merchant by their acquirer when they registered to use J/Secure.
Data can consist of any characters
String
CONDITIONAL
Merchant Password provided to the merchant by their acquirer when they registered to use J/Secure.
If a password is set, the field does not return the actual password, but the value 'xxxxxx'.
Data can consist of any characters
Details about the MasterCard SecureCode (3D-Secure) configuration for this merchant acquirer link.
String
CONDITIONAL
Merchant ID provided to the merchant by their acquirer when they registered to use MasterCard SecureCode.
Data can consist of any characters
String
CONDITIONAL
Merchant Password provided to the merchant by their acquirer when they registered to use MasterCard SecureCode.
If a password is set, the field does not return the actual password, but the value 'xxxxxx'.
Data can consist of any characters
Details about the Verified by Visa (3D-Secure) configuration for this merchant acquirer link.
String
CONDITIONAL
Card Acceptor ID provided to the merchant by their acquirer when they registered to use Verified by Visa (3-D Secure).
Data can consist of any characters
String
CONDITIONAL
Card Acceptor Terminal ID provided to the merchant by their acquirer when they registered to use Verified by Visa (3-D Secure).
Data can consist of any characters
String
CONDITIONAL
Merchant Password provided to the merchant by their acquirer when they registered to use Verified by Visa (3-D Secure).
If a password is set, the field does not return the actual password, but the value 'xxxxxx'.
Data can consist of any characters
Details that are specific for a specific acquirer.
Details regarding an AMEX_MAA acquirer link configuration.
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding an ANZAU_MAA acquirer link configuration.
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding an ANZNZ_MAA acquirer link configuration.
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
ANZ National Bank via MAA
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding a B+S Card Services acquirer link configuration.
Enumeration
CONDITIONAL
The industry code that the merchant operates in, as used by the financial institution.
Value must be a member of the following list. The values are case sensitive.
ADULT
AIRLINE
AUCTION
DIGITAL_CONTENT
E_TICKETING
GAMBLING
GAMING
HOTEL
ONLINE_FINANCIAL
RETAIL
SERVICES
TRAVEL
UTILITIES
Details regarding an BancaNet acquirer link configuration.
Digits
CONDITIONAL
The merchant's business or establishment number.
This field is mandatory only if the Payment Reference Type is "CAPTURE_A" or "CAPTURE_B".
Data is a number between 101 and 999999 represented as a string.
Digits
CONDITIONAL
The identifier used by BancaNet Directo to determine the destination of funds transfer.
The value for this field must be an integer and must not exceed 4 digits.
Data is a number between 0 and 9999 represented as a string.
Digits
CONDITIONAL
The merchant's Banamex Electronic Banking ID provided by the merchant when signing the BancaNet Directo contract.
The value for this field must be an integer and must not exceed 12 digits.
Data is a number between 0 and 999999999999 represented as a string.
Digits
CONDITIONAL
The identifier for the merchant's bank account number.
This must be the same bank account number, the bank details of which are registered against the BancaNet Directo account.
Data is a number between 0 and 9999999 represented as a string.
Digits
CONDITIONAL
The identifier for the bank branch that holds the merchant's account.
This must be the same bank, the account details of which are registered against the BancaNet Directo account.
Data is a number between 0 and 9999 represented as a string.
Enumeration
CONDITIONAL
The merchant's choice of payment reference type when signing the BancaNet Directo contract.
Value must be a member of the following list. The values are case sensitive.
ALPHANUMERIC
The gateway uses the algorithm MOD-97 to generate a alphanumeric Merchant Payment Reference.
BOTH
The gateway uses the algorithm MOD-97 to generate a numeric as well as an alphanumeric for the Merchant Payment Reference.
CAPTURE_A
The merchant's choice of payment reference type is the capture line A.
CAPTURE_B
The merchant's choice of payment reference type is the capture line B.
NUMERIC
The gateway uses the algorithm MOD-97 to generate a numeric Merchant Payment Reference.
Details regarding a Banorte acquirer link configuration.
Alphanumeric
CONDITIONAL
Provider password (Pwd) required to access the processing system.
The merchant receives this information when they set up an account with Banorte.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric
CONDITIONAL
Provider user name (Usr) required to access the processing system.
The merchant receives this information when they set up an account with Banorte.
Data may consist of the characters 0-9, a-z, A-Z
Bank of China via MAA
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding an BQL_MAA acquirer link configuration.
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
PT.
Bank Rakyat Indonesia (Persero) Tbk. via MAA
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding an CBA_MAA acquirer link configuration.
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding a CIC acquirer link configuration.
Enumeration
CONDITIONAL
The industry code that the merchant operates in, as used by the financial institution.
Value must be a member of the following list. The values are case sensitive.
ADULT
AIRLINE
AUCTION
DIGITAL_CONTENT
E_TICKETING
GAMBLING
GAMING
HOTEL
ONLINE_FINANCIAL
RETAIL
SERVICES
TRAVEL
UTILITIES
Alphanumeric
CONDITIONAL
Provider key (Key) required to access the processing system.
The merchant receives this information when they set up an account with CIC.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric
CONDITIONAL
Provider password (Passphrase) required to access the processing system.
The merchant receives this information when they set up an account with CIC
Data may consist of the characters 0-9, a-z, A-Z
Details regarding a Cielo acquirer link configuration.
Alphanumeric
CONDITIONAL
Provider key (chave) required to access the processing system.
The merchant receives this information when they set up an account with Cielo.
Data may consist of the characters 0-9, a-z, A-Z
Details regarding an DBS_MAA acquirer link configuration.
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding an DINERS_MAA acquirer link configuration.
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding a Giropay acquirer link configuration.
Digits
CONDITIONAL
The merchant is issued an Acquirer Merchant ID when they sign up with a giropay acquirer.
Data is a string that consists of the characters 0-9.
String
CONDITIONAL
The merchant is issued an External Merchant ID when they sign up with a giropay acquirer.
Data can consist of any characters
String
CONDITIONAL
The merchant is issued an External Merchant Tag when they sign up with a giropay acquirer.
Data can consist of any characters
Digits
CONDITIONAL
Bank account number of the merchant's bank account.
The customer will transfer the money into this bank account.
Data is a string that consists of the characters 0-9.
Digits
CONDITIONAL
Bank identifier of the merchant's bank account.
Must be 8 digits. Add leading zeros if required. The customer will transfer the money into this bank account.
Data is a string that consists of the characters 0-9.
String
CONDITIONAL
Bank account holder name of the merchant's bank account.
The customer will transfer the money into this bank account.
Data can consist of any characters
Details regarding a Global Payments East acquirer link configuration.
Digits
CONDITIONAL
The merchant's Bank Identification Number (BIN).
Will be submitted to the acquirer with each transactions sent for processing.
Data is a string that consists of the characters 0-9.
Details regarding a GWS acquirer link configuration.
String
CONDITIONAL
When submitting a transaction on behalf of a sub-merchants, this name may be displayed on the payer's cardholder statement (together with the sub-merchant name).
It may be up to 12 characters long and combined with the sub-merchant name must not exceed 37 characters. Use an abbreviation that will be meaningful to the payer when displayed on their statement.
Data can consist of any characters
Upper case alphabetic text
CONDITIONAL
The country location of the merchant.
The value must be a three-letter country code according to ISO 3166-1 alpha-3.
Data must consist of the characters A-Z
Details regarding an HSBC_MAA acquirer link configuration.
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding an HSBCMYH_MAA acquirer link configuration.
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Mashreq Bank via MAA
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding an NAB_MAA acquirer link configuration.
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding a Paymenttech Tampa acquirer link configuration.
Digits
CONDITIONAL
Sent to the acquirer in authorization, authorization reversals, sysreversals and batch settlement requests.
Data is a string that consists of the characters 0-9.
Details regarding a PayPal acquirer link configuration.
Email
CONDITIONAL
The email address of the merchant's PayPal business account.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
Email
CONDITIONAL
The email address of the merchant's PayPal Sandbox account.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
Details regarding a Redecard acquirer link configuration.
Alphanumeric
CONDITIONAL
Provider password (Pwd) required to access the processing system.
The merchant receives this information when they set up an account with Redecard.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric
CONDITIONAL
Provider user name (Usr) required to access the processing system.
The merchant receives this information when they set up an account with Redecard.
Data may consist of the characters 0-9, a-z, A-Z
Details regarding an S2I acquirer link configuration.
Decimal
CONDITIONAL
The acquirer is responsible for registering the merchant with MasterCard to allow the merchant to act as a Payment Facilitator (aggregator).
MasterCard will issue the merchant with a either Payment Facilitator ID or Independent Sales Organization ID. This ID will be submitted to the acquirer with every transaction.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
CONDITIONAL
The acquirer is responsible for registering the merchant with MasterCard to allow the merchant to act as a Payment Facilitator (aggregator).
MasterCard will issue the merchant with either a Payment Facilitator ID or Independent Sales Organization ID. This ID will be submitted to the acquirer with every transaction.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
CONDITIONAL
When submitting a transaction on behalf of a sub-merchants, this name may be displayed on the payer's cardholder statement (together with the sub-merchant name).
It may be 3, 7 or 12 characters long and combined with the sub-merchant name (as provided on the transaction request) must not exceed 21 characters. Use an abbreviation that will be meaningful to the payer when displayed on their statement.
Data can consist of any characters
Details regarding a Sofortbanking acquirer link configuration.
String
CONDITIONAL
The merchant must activate input verification in their Sofortbanking account.
The notification password must be the same as the one in the merchants Sofortbanking account and is used by to generate a hash value that is used to securely identify the messages received from Sofortbanking.
Data can consist of any characters
Digits
CONDITIONAL
The merchant is issued a Project ID (Projektnummer) when they sign up with Sofortbanking.
Data is a string that consists of the characters 0-9.
String
CONDITIONAL
The merchant must activate input verification in their Sofortbanking account.
The project password must be the same as the one in the merchants Sofortbanking account and is used to generate a hash value that is used to securely identify the messages sent to Sofortbanking.
Data can consist of any characters
Digits
CONDITIONAL
The merchant is issued a user ID (Kundennummer) when they sign up with Sofortbanking.
Data is a string that consists of the characters 0-9.
Details regarding an SUNCORP_MAA acquirer link configuration.
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding a TSYS acquirer link configuration.
String
CONDITIONAL
Identifies the institution that signs the merchant.
Data can consist of any characters
String
CONDITIONAL
The merchant chain identification number.
Data can consist of any characters
Digits
CONDITIONAL
The merchant's Bank Identification Number (BIN).
Will be submitted to the acquirer with each transactions sent for processing.
Data is a string that consists of the characters 0-9.
Digits
CONDITIONAL
Identifies a specific merchant store within the TSYS Acquiring Solutions' system.
Data is a string that consists of the characters 0-9.
String
CONDITIONAL
Processor specific time zone differential.
Data can consist of any characters
String
CONDITIONAL
The merchant assigned Terminal ID Number.
Data can consist of any characters
Details regarding a Vantiv acquirer link configuration.
Digits
CONDITIONAL
The merchant's Bank Identification Number (BIN).
Will be submitted to the acquirer with each transactions sent for processing.
Data is a string that consists of the characters 0-9.
Details regarding an VCB_MAA acquirer link configuration.
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding an WBC_NZ_MAA acquirer link configuration.
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding an WBCS2I_MAA acquirer link configuration.
String
CONDITIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
CONDITIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
CONDITIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
CONDITIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
The address of the merchant.
String
ALWAYS PROVIDED
The city or town of the merchant's billing address.
Data can consist of any characters
Upper case alphabetic text
ALWAYS PROVIDED
The country of the merchant's billing address.
The value must be a three-letter country code according to ISO 3166-1 alpha-3.
Data must consist of the characters A-Z
String
ALWAYS PROVIDED
The zip or postal code of the merchant's billing address.
Data can consist of any characters
String
ALWAYS PROVIDED
The state or province of the merchant's billing address.
Data can consist of any characters
String
ALWAYS PROVIDED
The street address of the merchant's billing address.
Data can consist of any characters
String
CONDITIONAL
The street address of the merchant's merchant's billing address.
Data can consist of any characters
Enumeration
ALWAYS PROVIDED
The card number masking format applied by the gateway when the merchant supplied the card number.
This format will be used for transactions originating from Web Services API and Merchant Administration.
Formats for masking card numbers.
Value must be a member of the following list. The values are case sensitive.
DISPLAY_0_4
Display last 4 digits of Card Number.
DISPLAY_6_3
Display first 6 and last 3 digits of Card Number.
DISPLAY_6_4
Display first 6 and last 4 digits of Card Number.
DISPLAY_FULL
Display Full Card Number.
DISPLAY_NONE
Display No Card Number.
Digits
ALWAYS PROVIDED
A 4 digit industry specific code that describes the business or industry the merchant operates in.
Data is a string that consists of the characters 0-9.
String
CONDITIONAL
The Certificate Set ID is a unique identifier that you have assigned to uniquely identify a merchant's test and production SSL certificates.
Provide this field if the merchant will use SSL certificates to authenticate to the gateway when using the API. If not provided, the merchant will be enabled for Password Authentication.
If your customer has multiple gateway merchant profiles, then they can share the same Certificate Set. In this case, provide the same Certificate Set ID for each of their gateway merchant profiles.
You can create Certificate Sets for your merchants from the Merchant Manager UI.
Data can consist of any characters
String
CONDITIONAL
The name of the person to contact within the merchant's business.
Data can consist of any characters
Configuration details to enable the Dynamic Currency Conversion (DCC) service.
DCC enables merchants to accept payments from payers in their currency, which can differ from the merchant's currency for the order.
Upper case alphabetic text
CONDITIONAL
The base currency registered for the merchant ID at the DCC provider.
The value must be expressed as an ISO 4217 alpha code.
Data must consist of the characters A-Z
Alpha
CONDITIONAL
The identifier for the acquirer the merchant has registered with the DCC provider.
Data may consist of the characters a-z, A-Z
Enumeration
ALWAYS PROVIDED
DCC rate quote providers.
Value must be a member of the following list. The values are case sensitive.
FEXCO
FEXCO DCC provider.
TRAVELEX_CURRENCY_SELECT
Travelex DCC provider.
Alphanumeric
CONDITIONAL
The unique identifier for the merchant account at the DCC provider.
Data may consist of the characters 0-9, a-z, A-Z
Enumeration
ALWAYS PROVIDED
The currency conversion rate that will apply to a refund transaction executed against an exiting order.
The currency conversion rate that will apply to a refund transaction executed against an existing order.
Value must be a member of the following list. The values are case sensitive.
CURRENT
A new rate quote is being requested to provide the actual rate at the refund transaction date.
HISTORICAL
The rate used when the order was created.
Enumeration
ALWAYS PROVIDED
Specifies the Visa disclosure region for the merchant.
This determines the Dynamic Currency Conversion offer and receipt texts presented to the payer.
Value must be a member of the following list. The values are case sensitive.
EUROPE
The Visa disclosure rules for Europe
INTERNATIONAL
The Visa disclosure rules for the International region
Enumeration
CONDITIONAL
Sets the value of order certainty assumed on a merchants orders where they do not specify one in the API request.If you do not specify this value, when updating a merchant profile for whom transactionMode is AUTH_CAPTURE, it will be set to FINAL.
Value must be a member of the following list. The values are case sensitive.
ESTIMATED
Merchant's orders will be assumed to have an order certainty of ESTIMATED where none is specified in WS-API requests.
FINAL
Merchant's orders will be assumed to have an order certainty of FINAL where none is specified in WS-API requests.
Email
CONDITIONAL
The email address of the person to contact within the merchant's business.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
CONDITIONAL
The phone number to call in case the regular phone number is not available.
Data can consist of any characters
Integer
CONDITIONAL
Defines the excess amount permitted to be captured on the original authorized amount, as a percentage.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
String
CONDITIONAL
The fax number of the merchant's business.
Data can consist of any characters
String
ALWAYS PROVIDED
Description of the merchant's goods, for example, books or electronics.
Data can consist of any characters
Alphanumeric + additional characters
ALWAYS PROVIDED
The unique identifier issued to you by your payment provider.
This identifier can be up to 12 characters in length.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
String
ALWAYS PROVIDED
The default language displayed in Merchant Administrator unless overridden by the Operator.
The value must be provided in the format '<Language>_<Country>', e.g. 'en_US'. <Language> must be a two-letter language code according to ISO 639-1. <Country> must be a two-letter country code according to ISO 3166-1 alpha-2.
Data can consist of any characters
Details regarding the merchant's MasterPass Online configuration.
Alphanumeric
ALWAYS PROVIDED
A unique identifier for the merchant in the MasterPass Online system, issued by MasterPass Online when boarding the merchant.
Data may consist of the characters 0-9, a-z, A-Z
Boolean
CONDITIONAL
If enabled, the payer's shipping address is collected at MasterPass Online and returned to the merchant in the transaction response
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
String
CONDITIONAL
The consumer key value as issued by Masterpass for the merchant's production profile.
Data can consist of any characters
String
CONDITIONAL
The consumer key value as issued by Masterpass for the merchant's sandbox profile.
Data can consist of any characters
Alphanumeric
CONDITIONAL
The shipping location defines which countries the merchant ships to and restricts the customer's shipping address selection in MasterPass Online accordingly.
If provided, this shipping location applies for all MasterPass Online transactions. If not provided, MasterPass Online uses the preferred shipping profile configured against the merchant's MasterPass Online profile.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric + additional characters
CONDITIONAL
The merchant organizations that this merchant belongs to.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
String
CONDITIONAL
The mobile phone number to call in case the regular phone number is not available.
Data can consist of any characters
String
ALWAYS PROVIDED
The merchant's registered business, trading or organization name.
Data can consist of any characters
String
CONDITIONAL
A unique ID of the reseller partner or a referral partner the merchant has signed up with, to use the services offered by the MSO.
Providing this ID will help in tracking and analyzing the relationship between partners and their merchants, which may be useful for billing and reporting purposes.
Data can consist of any characters
String
CONDITIONAL
The phone number of the merchant's business.
Data can consist of any characters
Enumeration
CONDITIONAL
The privileges available to the merchant.
Value must be a member of the following list. The values are case sensitive.
ALLOW_LEVEL_2_ORDER_CREATION
Enables the merchant to create level 2 orders, i.e. provide level 2 specific data when creating an order.
BULK_CAPTURES
Enables the merchant to perform multiple captures using a single action in Merchant Administration.
CASH_ADVANCE
Enables the merchant to submit Cash Advance transactions.
CHANGE_MERCHANT_TRANSACTION_SOURCE
Enables the merchant to provide the source of the transaction when creating the transaction. If not enabled or not provided by the merchant, the gateway automatically assigns the default transaction source.
CHANGE_ORDER_CERTAINTY
Enables the merchant to make use of a value of order certainty other than their configured default (see defaultOrderCertainty) by supplying it in WS-API requests or in the Create Order UI.
CHANGE_TRANSACTION_FREQUENCY
Enables the merchant to change the frequency of a transaction.
ENABLE_REFUND_REQUESTS
Enables an operator to request approval for a refund transaction. The refund transaction is not submitted to the acquirer.
ENFORCE_CARD_NUMBER_MASKING_FOR_INPUT
Enforces card masking when entering a payer's card number in Merchant Administration.
ENFORCE_UNIQUE_MERCHANT_TRANSACTION_REFERENCE
Enforces a unique Merchant Transaction Reference for every transaction submitted by the merchant. Transactions without a unique Merchant Transaction Reference are rejected by the gateway.
ENFORCE_UNIQUE_ORDER_REFERENCE
Enforces a unique Order Reference across all orders submitted by the merchant. Transactions without a uniqueOrder Reference are rejected by the gateway.
EXCESSIVE_REFUNDS
Enables the merchant to perform refunds for amounts greater than the authorized amount.
MANUAL_BATCH_CLOSURE
Enables the merchant to manually trigger settlement for a batch in Merchant Administration or via the 'Close Batch' Web Services API operation.
MOTO
Enables the merchant to manually create orders in Merchant Administration.
NO_CARDS_SUBMITTED_THROUGH_API_SAQ_A
Support merchant to meet SAQ-A obligation when using merchant user interfaces
NO_CARDS_SUBMITTED_THROUGH_UI_SAQ_A
Support merchant to meet SAQ-A obligation when using merchant user interfaces.
ORDER_DOWNLOAD
Enables the merchant to download order level data in CSV format.
REFUNDS
Enables the merchant to create refunds. A refund is the transfer of funds from a merchant to the payer's account.
STANDALONE_CAPTURES
Enables the merchant to perform a capture without first performing an authorization. The merchant must perform the authorization externally, and provide the corresponding authorization code as input to the stand alone capture.
STANDALONE_REFUNDS
Enables the merchant to perform a refund without first creating an order (with a capture or purchase).
STATEMENT_DESCRIPTOR
Enables the merchant to print their contact information on payer's account statements.
TXN_DOWNLOAD
Enables the merchant to download transaction level data in CSV format.
VIEW_SETTLEMENT_PAGES
Enables the merchant to view batch settlement details in Merchant Administration.
VIEW_UNMASKED_ACCOUNT_IDENTIFIERS
Enables the merchant to allow merchant operators to view unmasked account identifiers in Merchant Administration.
VIEW_UNMASKED_SENSITIVE_DATA
Enables the merchant to allow merchant operators to view unmasked sensitive data in Merchant Administration.
VOIDS
Enables the merchant to void transactions. A void is the cancellation of a previous transaction. Voids can only be performed if the transaction is in an unreconciled batch and if the operation is supported by the acquirer.
Details regarding the merchant's risk configuration.
Configuration details for the external risk profile
Configuration details for the GateKeeper profile
Enumeration
CONDITIONAL
Defines when the gateway sends the transaction to the external risk provider for risk scoring.
Value must be a member of the following list. The values are case sensitive.
AFTER_TRANSACTION_PROCESSING
The request includes relevant data elements from the merchant's transaction request, a globally unique transaction identifier, a risk assessment identifier generated by the payment gateway together with relevant transaction response data from the Acquirer. AVS and CSC results are available for risk assessment.
BEFORE_TRANSACTION_PROCESSING
The request includes relevant data elements from the merchant's transaction request, a globally unique transaction identifier, and a risk assessment identifier generated by the payment gateway. No AVS, CSC or other Acquirer response data is available. Please note that, if you select external risk only (i.e. not internal risk) and "May Use Verification Only for AVS/CSC Risk Assessment" then "Before transaction processing" is not a valid option. This is because the only reason to use the Verification Only transaction is to obtain AVS and CVC results for use in risk assessment. If the risk assessment decision has already been made then performing the Verification Only transaction is an additional and unnecessary action.
Enumeration
CONDITIONAL
Indicates the action to be taken when the gateway is unable to get risk scoring from GateKeeper, for example, due to connectivity issues.
Value must be a member of the following list. The values are case sensitive.
ACCEPT_NOT_CHECKED
The gateway allows the order to progress and risk assessment will not be performed. The risk recommendation for the order will be set to "Not Checked".
REVIEW
The merchant must review the order and accept or reject the order.
Enumeration
CONDITIONAL
The risk scoring status for the external risk provider.
Value must be a member of the following list. The values are case sensitive.
TEST_AND_PRODUCTION
The external risk provider will assess both test and live transactions for risk scoring.
TEST_ONLY
The external risk provider will assess only test transactions for risk scoring.
String
CONDITIONAL
The GateKeeper merchant ID used to identify the GateKeeper profile linked to this merchant profile.
Data can consist of any characters
String
CONDITIONAL
The unique identifier for this external risk profile.
When using an existing profile this must be the profile name as defined at the external risk provider. When creating a new profile, the name cannot be subsequently updated and should indicate the merchant or merchant group assigned.
Data can consist of any characters
Enumeration
CONDITIONAL
The service level offering that the Merchant has signed up to with GateKeeper.
Value must be a member of the following list. The values are case sensitive.
GOLD
The Gold service level.
Enumeration
CONDITIONAL
A GateKeeper Profile can support risk scoring for one or many Merchant Profiles. An organisation with multiple Merchant Profiles may use a single GateKeeper Profile to minimise risk management overheads and to leverage their collective experience of trading with customers. However, if the Merchant Profiles have significantly different business models such as different typical order values or customer purchase patterns, consideration should be given to setting up separate GateKeeper Profiles.
Value must be a member of the following list. The values are case sensitive.
MULTIPLE_MERCHANT_PROFILES
The profile supports being assigned to multiple merchants.
SINGLE_MERCHANT_PROFILE
The profile only supports being assigned to a single merchant.
String
CONDITIONAL
The GateKeeper merchant ID used to identify the GateKeeper profile linked to this merchant profile.
Data can consist of any characters
Configuration details for the Interceptas profile
Enumeration
CONDITIONAL
Defines when the gateway sends the transaction to the external risk provider for risk scoring.
Value must be a member of the following list. The values are case sensitive.
AFTER_TRANSACTION_PROCESSING
The request includes relevant data elements from the merchant's transaction request, a globally unique transaction identifier, a risk assessment identifier generated by the payment gateway together with relevant transaction response data from the Acquirer. AVS and CSC results are available for risk assessment.
BEFORE_TRANSACTION_PROCESSING
The request includes relevant data elements from the merchant's transaction request, a globally unique transaction identifier, and a risk assessment identifier generated by the payment gateway. No AVS, CSC or other Acquirer response data is available. Please note that, if you select external risk only (i.e. not internal risk) and "May Use Verification Only for AVS/CSC Risk Assessment" then "Before transaction processing" is not a valid option. This is because the only reason to use the Verification Only transaction is to obtain AVS and CVC results for use in risk assessment. If the risk assessment decision has already been made then performing the Verification Only transaction is an additional and unnecessary action.
Email
CONDITIONAL
The Interceptas tenant's billing contact email.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
ALWAYS PROVIDED
The Interceptas tenant's billing contact name.
Data can consist of any characters
String
CONDITIONAL
The Interceptas tenant's billing contact phone.
Data can consist of any characters
Email
CONDITIONAL
The Interceptas tenant's business contact email.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
CONDITIONAL
The Interceptas tenant's business contact name.
Data can consist of any characters
String
CONDITIONAL
The Interceptas tenant's business contact phone.
Data can consist of any characters
Enumeration
CONDITIONAL
This identifies the type of business that your Merchant is in and influences the risk assessment that will be performed by Interceptas.
Value must be a member of the following list. The values are case sensitive.
AIRLINE_TRAVEL_AGENT
Airline/Travel Agent.
RETAILER_OF_DIGITAL_GOODS
Retailer of digital goods.
RETAILER_OF_PHYSICAL_GOODS
Retailer of physical goods.
Upper case alphabetic text
CONDITIONAL
Currency is used by Interceptas to define the risk rules (e.g. average order size).
Any transactions submitted to Interceptas using a different currency will be converted to the corresponding value in the base currency before being risk assessed. The value must be expressed as an ISO 4217 alpha code.
Data must consist of the characters A-Z
Enumeration
CONDITIONAL
Indicates the action to be taken when the gateway is unable to get risk scoring from Interceptas, for example, due to connectivity issues. For a merchant with the service level "Bronze", the only valid option is "Accept - Not Checked" as the merchant cannot perform a review.
Value must be a member of the following list. The values are case sensitive.
ACCEPT_NOT_CHECKED
The gateway allows the order to progress and risk assessment will not be performed. The risk recommendation for the order will be set to "Not Checked".
REVIEW
The merchant must review the order and accept or reject the order.
Enumeration
CONDITIONAL
The risk scoring status for the external risk provider.
Value must be a member of the following list. The values are case sensitive.
TEST_AND_PRODUCTION
The external risk provider will assess both test and live transactions for risk scoring.
TEST_ONLY
The external risk provider will assess only test transactions for risk scoring.
String
CONDITIONAL
The default language which will be used when users sign into Interceptas.
The value must be provided in the format '<Language>_<Country>', e.g. 'en_US'. <Language> must be a two-letter language code according to ISO 639-1. <Country> must be a two-letter country code according to ISO 3166-1 alpha-2.
Data can consist of any characters
String
CONDITIONAL
The password used to authenticate this merchant profile on the Interceptas scoring module.
Data can consist of any characters
Url
CONDITIONAL
The Interceptas URL to which the payment gateway sends the risk scoring request.
Ensure that the URL begins with 'https' and is longer than 11 characters.
String
CONDITIONAL
The tenant ID used to identify the Interceptas tenant linked to this merchant profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to identify this merchant profile on the Interceptas scoring module.
Data can consist of any characters
String
CONDITIONAL
The unique identifier for this external risk profile.
When using an existing profile this must be the profile name as defined at the external risk provider. When creating a new profile, the name cannot be subsequently updated and should indicate the merchant or merchant group assigned.
Data can consist of any characters
Enumeration
CONDITIONAL
The service level offering that the Merchant has signed up to with Accertify.
Value must be a member of the following list. The values are case sensitive.
BRONZE
The Bronze service level.
GOLD
The Gold service level.
SILVER
The Silver service level.
Enumeration
CONDITIONAL
An Interceptas Tenant can support risk scoring for one or many Merchant Profiles. An organisation with multiple Merchant Profiles may use a single Interceptas Tenant to minimise risk management overheads and to leverage their collective experience of trading with customers. However, if the Merchant Profiles have significantly different business models such as different typical order values or customer purchase patterns, consideration should be given to setting up separate Interceptas Tenants.
Value must be a member of the following list. The values are case sensitive.
MULTIPLE_MERCHANT_PROFILES
The tenant supports being assigned to multiple merchants.
SINGLE_MERCHANT_PROFILE
The tenant only supports being assigned to a single merchant.
Email
CONDITIONAL
The Interceptas tenant's technical contact email.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
ALWAYS PROVIDED
The Interceptas tenant's technical contact name.
Data can consist of any characters
String
CONDITIONAL
The Interceptas tenant's technical contact phone.
Data can consist of any characters
String
CONDITIONAL
The password used to authenticate this merchant profile on the Interceptas scoring module.
Data can consist of any characters
Url
CONDITIONAL
The Interceptas URL to which the payment gateway sends the risk scoring request.
Ensure that the URL begins with 'https' and is longer than 11 characters.
String
CONDITIONAL
The tenant ID used to identify the Interceptas tenant linked to this merchant profile.
Data can consist of any characters
String
CONDITIONAL
The user name used to identify this merchant profile on the Interceptas scoring module.
Data can consist of any characters
String
CONDITIONAL
The default timezone which will be used when users sign into Interceptas.
The value must be provided in the form '<Continent>/<City>', e.g. 'America/New_York'. For a complete list of timezones please refer to http://twiki.org/cgi-bin/xtra/tzdatepick.html.
Data can consist of any characters
Enumeration
CONDITIONAL
The unique identifier for this external risk provider issued by the gateway.
Merchant Boarding API supported external risk providers
Value must be a member of the following list. The values are case sensitive.
GATEKEEPER
INTERCEPTAS
Enumeration
CONDITIONAL
Risk management privileges assigned to the merchant.
Value must be a member of the following list. The values are case sensitive.
RISK_VERIFY_ONLY
Allows the gateway to submit a Verification Only transaction to the acquirer to obtain the AVS and CSC results for use in risk assessment. This avoids having to perform the financial transaction before risk assessment and the need to release the hold on cardholder funds in the event the transaction is rejected due to risk assessment.
SYSTEM_REFUND
Allows the gateway to refund against an order if risk assessment rejects the order after the financial transaction has successfully been performed. This privilege is required only, if the Refunds privilege is not enabled.
Enumeration
CONDITIONAL
The services available to the merchant.
Value must be a member of the following list. The values are case sensitive.
ENABLE_AMEX_EXPRESS_CHECKOUT
Enables the merchant to use the Amex Express Checkout digital wallet to collect the payer's payment details.
ENABLE_BATCH
Enables the merchant to integrate with the gateway via the Batch API. The Authentication mode is set to 'Password Authentication'.
ENABLE_CHECKOUT
Enables the merchant to collect the payer's payment details using a Hosted Checkout.
ENABLE_HOSTED_PAYMENT_FORM
Enables the merchant to collect the payer's payment details through their own payment form while submitting them directly from the payer's browser to the gateway.
ENABLE_INTERNAL_RISK
Enables the merchant to use the internal risk management module to risk assess transactions performed through the gateway.
ENABLE_MASTERPASS_ONLINE
Enables the merchant to use the MasterPass Online digital wallet to collect the payer's payment details.
ENABLE_NOTIFICATIONS
Enables the merchant to configure merchant email notifications as well as customer email notifications.
ENABLE_PAYMENTS_WITHOUT_AUTHENTICATION
Enables the merchant to process payments without any merchant authentication.
ENABLE_REPORTING_API
Enables the merchant to integrate with the gateway via the Reporting API.
ENABLE_VISA_CHECKOUT
Enables the merchant to use the Visa Checkout digital wallet to collect the payer's payment details.
ENABLE_WEB_SERVICES_API
Enables the merchant to integrate with the gateway via the Web Services API. The Authentication mode is set to 'Password Authentication'.
Enumeration
CONDITIONAL
Use this field to indicate whether or not the merchant may use gateway features configured on their merchant profile.
By default this field is set to ENABLED.
Value must be a member of the following list. The values are case sensitive.
DISABLED
The merchant cannot use any of the gateway features configured on their merchant profile and cannot log into merchant UIs.
ENABLED
The merchant may use all of the gateway features configured on their merchant profile and may also log into merchant UIs.
Enumeration
ALWAYS PROVIDED
The card number masking format applied by the gateway when the card number was supplied by the customer rather than the merchant.
This format will be used for transactions originating from Hosted Payment Form integrations.
Formats for masking card numbers.
Value must be a member of the following list. The values are case sensitive.
DISPLAY_0_4
Display last 4 digits of Card Number.
DISPLAY_6_3
Display first 6 and last 3 digits of Card Number.
DISPLAY_6_4
Display first 6 and last 4 digits of Card Number.
DISPLAY_FULL
Display Full Card Number.
DISPLAY_NONE
Display No Card Number.
String
ALWAYS PROVIDED
Defines the default time zone used for merchant operators in Merchant Administration, unless overridden by the operator.
It is used to display the transaction time. The value must be provided in the form '<Continent>/<City>', e.g. 'America/New_York'. For a complete list of timezones please refer to http://twiki.org/cgi-bin/xtra/tzdatepick.html.
Data can consist of any characters
Configuration details for the Tokenization functionality.
Details regarding the token repository configuration.
Enumeration
CONDITIONAL
Defines the strategy used to generate a token.
Mandatory, if repository must be created.
Value must be a member of the following list. The values are case sensitive.
MERCHANT_SUPPLIED
Tokens are supplied by the merchant. Any merchant supplied token is validated to not be a valid card number.
PRESERVE_6_4
Tokens are generated preserving the first 6 and last 4 digits of the account identifier, e.g. card number. The remaining digits are randomized, and the token is guaranteed to fail a Luhn (Mod-10) check so that it does not create a valid card number.
RANDOM_WITH_LUHN
Tokens are generated as random numbers. It starts with a '9' (so that is does not create a valid card number) and passes a Luhn (Mod-10) check.
Enumeration
CONDITIONAL
Defines how tokens within the repository are managed by the gateway.
Mandatory, if repository must be created.
Value must be a member of the following list. The values are case sensitive.
UNIQUE_ACCOUNT_IDENTIFIER
A single token is assigned against an account identifier, defines as a one-to-one relationship between the account identifier and the token. An attempt to store the account identifier against another token will result in an error.
UNIQUE_TOKEN
A unique token is assigned every time an account identifier is saved in the token repository, defining a one-to-many relationship between an account identifier and the token.
ASCII Text
CONDITIONAL
Unique identifier of the token repository.
Token repositories can be shared across merchants; however, a single merchant can be associated with only one token repository at a given time. Every token repository has a corresponding test token repository, which only the merchants with the corresponding test profiles can access. For example, if the repository ID is ABC, the test repository ID will be TestABC. Hence, the system displays an error if you specify a repository ID that starts with 'Test'
Data consists of ASCII characters
Enumeration
CONDITIONAL
The type of verification performed by the gateway for payment details stored against a token repository for this merchant.
Value must be a member of the following list. The values are case sensitive.
ACQUIRER
The gateway performs a Web Services API Verify request. Depending on the payment type, you may need to provide additional details to enable the submission of a Verify request.
BASIC
The gateway validates the format of the payment details. For cards it also validates that the card number falls within a valid BIN range. For ACH payment details it also validates the check digit for the routing number
NONE
The gateway does not perform any verification.
String
CONDITIONAL
A unique identifier allocated to the merchant by your payment service provider if different from the Merchant ID.
Data can consist of any characters
String
CONDITIONAL
The trading name of the merchant's business if it is different to that of the company name.
Data can consist of any characters
Enumeration
ALWAYS PROVIDED
Defines the merchants transaction mode, i.e. if the funds are immediately requested to be moved from the payer's account or the payment is authorized only and the funds will be moved/captured later.
Value must be a member of the following list. The values are case sensitive.
AUTH_CAPTURE
The payment is authorized only (AUTHORIZATION transaction). The merchant must submit a Capture request to move the funds from the payer's account to the merchant's account.
PURCHASE
The payment happens immediately (PURCHASE transaction). The funds are immediately moved from the payer's account to the merchant's account.
DateTime
ALWAYS PROVIDED
The time stamp indicating the last update to the merchant's profile configuration.
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
Url
CONDITIONAL
URL of the merchant's website.
This is mandatory if the merchant is enrolled in a 3DSecure scheme.
Ensure that the URL begins with 'https' and is longer than 11 characters.
Enumeration
ALWAYS PROVIDED
A system-generated high level overall result of the operation.
Value must be a member of the following list. The values are case sensitive.
FAILURE
The operation was declined or rejected by the gateway, acquirer or issuer
PENDING
The operation is currently in progress or pending processing
SUCCESS
The operation was successfully processed
UNKNOWN
The result of the operation is unknown
Errors
Information on possible error conditions that may occur while processing an operation using the API.
Enumeration
Broadly categorizes the cause of the error.
For example, errors may occur due to invalid requests or internal system failures.
Value must be a member of the following list. The values are case sensitive.
INVALID_REQUEST
The request was rejected because it did not conform to the API protocol.
REQUEST_REJECTED
The request was rejected due to security reasons such as firewall rules, expired certificate, etc.
SERVER_BUSY
The server did not have enough resources to process the request at the moment.
SERVER_FAILED
There was an internal system failure.
String
Textual description of the error based on the cause.
This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.
Data can consist of any characters
String
Indicates the name of the field that failed validation.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Data can consist of any characters
String
Indicates the code that helps the support team to quickly identify the exact cause of the error.
This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.
Data can consist of any characters
Enumeration
Indicates the type of field validation error.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Value must be a member of the following list. The values are case sensitive.
INVALID
The request contained a field with a value that did not pass validation.
MISSING
The request was missing a mandatory field.
UNSUPPORTED
The request contained a field that is unsupported.
Enumeration
A system-generated high level overall result of the operation.
Value must be a member of the following list. The values are case sensitive.
ERROR
The operation resulted in an error and hence cannot be processed.